Skip to main content

Detail Backup by ID

This API returns detailed information about a specific backup identified by ID, including its metadata, integrity checksums, and per-service data.

Endpoint Details

URL/v1/backup/id
MethodGET
AuthorizationBearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Request Path

To retrieve the details of a specific backup, use the following request format:

/v1/backup/a0a5a0f5-1a2e-4693-887f-7b7dc687a661

Path Parameter

ParameterTypeDescription
idUUIDUnique identifier of the backup

Response

Here is an example of a response when viewing data details:

Response
{
"data": {
"id": "a0a5a0f5-1a2e-4693-887f-7b7dc687a661",
"file_name": "auto-backup-20260718-100000",
"description": "Automatic backup",
"status": 3,
"scopes": [
1,
2,
4,
3
],
"destination_type": 1,
"destination_path": "/tmp/takakrypt/backups/auto-backup-20260718-100000.tar.gz.enc",
"file_size": 1260006,
"checksum": "5729ea1ea4966621182b26854b55a9bfad2c7a588292e2f9db078d5326c3515d",
"created_by": "414a45e9-f194-4a8a-9876-97abb990d4d9",
"created_by_name": "Iqbal Adhi",
"created_at": 1784343600,
"completed_at": 1784343673,
"error_message": "partial failure: services [audit] failed to export",
"service_data": [
{
"service_name": "tokenize",
"scopes": [
1
],
"data_size": 21660,
"checksum": "8b9ffac1f4db26b6656e0e75673b0ba66bc7de30b907f993f2ff1ec06170d0b9",
"collected_at": 1784343600
},
{
"service_name": "masking",
"scopes": [
1
],
"data_size": 3623,
"checksum": "c5165d933a143b9a5f97e4e54910f74a667ff192bbc1b946bd06c2fc1b71ae47",
"collected_at": 1784343600
},
{
"service_name": "crypto",
"scopes": [
1
],
"data_size": 66591,
"checksum": "b4f5263835be0bf1c22706c0c33f0ac6ab40bfb94c72f5de5391249be44008a8",
"collected_at": 1784343600
},
{
"service_name": "auth",
"scopes": [
1
],
"data_size": 109642,
"checksum": "2c48171eb924b2524502bba8f942866987b3bf6faaf61b00d9a4bdcc65f6da64",
"collected_at": 1784343600
},
{
"service_name": "lock",
"scopes": [
2
],
"data_size": 2203648,
"checksum": "336d6344321384c57ad1cf80be1998e2e71fa604973e1c676262ea976664729b",
"collected_at": 1784343600
}
]
}
}

Field Descriptions

FieldTypeDescription
idUUIDUnique identifier of the backup
file_nameStringName of the backup file
descriptionStringDescription of the backup
statusIntegerCurrent status code of the backup
scopesArrayList of scope codes included in the backup
destination_typeIntegerType of backup destination
destination_pathStringPath where the backup file is stored
file_sizeIntegerSize of the backup file in bytes
checksumStringChecksum used to verify the integrity of the backup file
created_byUUIDIdentifier of the user who created the backup
created_by_nameStringDisplay name of the user who created the backup
created_atIntegerCreation timestamp in Unix format
completed_atIntegerCompletion timestamp in Unix format
error_messageStringError message describing any partial or full failure
service_dataArrayList of per-service data included in the backup
service_data.service_nameStringName of the service the data was collected from
service_data.scopesArrayList of scope codes collected for the service
service_data.data_sizeIntegerSize of the collected data for the service, in bytes
service_data.checksumStringChecksum used to verify the integrity of the service data
service_data.collected_atIntegerTimestamp when the service data was collected, in Unix format

info
  • A valid Bearer Token is required to access this endpoint.
  • The id path parameter must reference an existing backup.
  • The scopes array (both at the backup level and within service_data) uses the following codes:
    • 1 = System Configuration
    • 2 = Keys
    • 3 = Audit Log
    • 4 = System Log
  • The checksum fields can be used to verify the integrity of the backup file and each service's collected data.
  • The error_message field is only present when the backup completed with a partial or full failure.
  • Unix timestamp fields can be converted to a human-readable date and time format as needed.